/*
 * This file is part of Super Luigi Bros.
 * Super Luigi Bros is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Super Luigi Bros is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Super Luigi Bros.  If not, see <http://www.gnu.org/licenses/>.
 */

package luigibros.logic;

/** This interface is for general use
 *to encompass all objects which will
 *actually move on the screen due to 
 *user commands or programmed paths.
 *
 *@author Kinik
 */
public interface Movable {
        /**     <code>getDirectionType()</code> is a
         * method which will be overridden in
         * all classes which implement <code>
         * Movable</code> interface.  
         * 
         * @return direction--a DirectionType
         * value which describes the object's 
         * orientation on the grid (0 
         * for left, 1 for right)
         */
        public DirectionType getDirectionType();
        
        /**     <code>setDirection()</code> is a
         * method which will be overridden in
         * all classes which implement <code>
         * Movable</code> interface.  
         * 
         * @param dir--a byte value to set
         * the current orientation of the 
         * object
         * @return void
         */
        public void setDirection(byte dir);
        /**     <code>moveToNextLocation()</code> is a
         * method which will be overridden in
         * all classes which implement <code>
         * Movable </code>.  
         * 
         * @param location--a double value 
         * which signifies the position on
         * the screen to which the object 
         * must now be moved.
         * 
         * @return success--an boolean value
         * which signifies whether the object 
         * has successfully moved to the 
         * supplied location
         */
        public boolean moveToNextLocation(double location);
}


